Send

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODMessageInterface

Send
The Send method sends the specified Apple event object and requests a reply if appropriate.
void Send (in ODFrame toFrame,
           in ODPart fromPart,
           in ODAppleEvent theAppleEvent, 
           in ODAppleEvent reply, 
           in ODSendMode sendMode, 
           in ODSendPriority sendPriority, 
           in ODULong timeOutInTicks);
toFrame
A reference to a frame belonging to the part sending the Apple event object, or kODNULL if the part sending the Apple event object has no frame.
fromPart
A reference to the part sending the Apple event object.
theAppleEvent
A reference to an Apple event object to send.
reply
A reference to a reply Apple event object to be returned.
sendMode
The flags that specify the interactions between the sending and receiving parts.
sendPriority
The priority of the event.
timeOutInTicks
The number of ticks to wait for a reply before generating a time-out exception, expressed in ticks (60ths of a second).

DISCUSSION
The Apple Event Manager defines constants that can be used for the sendMode and sendPriority parameters. These constants are described in the "Creating and Sending Apple Events" chapter of Inside Macintosh: Interapplication Communication.
Before calling this method, you must create the Apple event object to send using the message interface's CreateEvent method. Your part is responsible for deleting both the Apple event object and any reply that was returned.

EXCEPTIONS
This method may throw platform-specific exceptions.

SEE ALSO
The ODSendMode type (page 925).
The ODSendPriority type (page 925).
The ODMessageInterface::CreateEvent method (page 412).
The ODMessageInterface::CreatePartAddrDesc method (page 414).
The ODAppleEvent class (page 41).
Table 9-1 on page 408 in OpenDoc Programmer's Guide.
"Sending the Event" on page 438 in OpenDoc Programmer's Guide.